Publish Crates, Npm Package and Usage Docs #21
Conversation
Codecov Report
@@ Coverage Diff @@
## main #21 +/- ##
==========================================
+ Coverage 79.91% 80.05% +0.13%
==========================================
Files 9 9
Lines 712 732 +20
==========================================
+ Hits 569 586 +17
- Misses 143 146 +3
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
appcypher
changed the title
appcypher
force-pushed
the
appcypher/packages-doc-examples
branch
from
8cb532b to
f466363
Compare
appcypher
force-pushed
the
appcypher/packages-doc-examples
branch
from
de5b22e to
e60649d
Compare
README.md
Outdated
| @@ -85,9 +180,9 @@ Its goal is to be as dependency-less as possible in order to be easily compiled | |||
|
|
|||
| </details> | |||
|
|
|||
| - **The _wnfs_ Helper Script** | |||
| - **The _wnfs_ Command** | |||
There was a problem hiding this comment.
Maybe we should rename the script in order to avoid confusion with a potential wnfs CLI that actually reads and writes WNFS similar to what the ipfs CLI is doing today.
Or we could go for a Justfile which is similar to a makefile, but simpler. We're using it in a lot of other places at fission.
And lastly we could go for a nix version, but that's way more involved to set up compared to a justfile.
There was a problem hiding this comment.
I was considering make but had issues with it in the past. Just looks like an improved make. I'm going to switch to it later.
I agree with renaming it. Maybe rs-wnfs because it is specific to the repo?
There was a problem hiding this comment.
How about build-wnfs.sh? Or maybe make-wnfs?
Summary
This PR implements the following features
This PR just prepares the project for package publishing (npm, doc.rs, crates.io). Also adds usage examples.
WNFS NPM package:
WNFS crates:
Examples of WNFS usage here:
JavaScript:
Rust:
Test plan (required)
N/AOngoing Issues
Closing issues
Fixes #22